/*
 * Copyright 2025, AutoMQ HK Limited.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.automq.stream.api;

import java.util.Optional;
import java.util.concurrent.CompletableFuture;

/**
 * Stream client, support stream create and open operation.
 */
public interface StreamClient {
    /**
     * Create and open stream.
     *
     * @param options create stream options.
     * @return {@link Stream}.
     */
    CompletableFuture<Stream> createAndOpenStream(CreateStreamOptions options);

    /**
     * Open stream.
     *
     * @param streamId stream id.
     * @param options  open stream options.
     * @return {@link Stream}.
     */
    CompletableFuture<Stream> openStream(long streamId, OpenStreamOptions options);

    /**
     * Retrieve an opened stream.
     *
     * @param streamId stream id.
     * @return {@link Optional<Stream>}.
     */
    Optional<Stream> getStream(long streamId);

    void shutdown();
}
